<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: debug.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('debug_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">debug.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Network interface for debugging purposes.  
<a href="#details">More...</a></p>

<p><a href="debug_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__debug__t.html">ec_debug_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debugging network interface.  <a href="structec__debug__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa8debb37c58f6813ddefa8233095f496"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#aa8debb37c58f6813ddefa8233095f496">ec_debug_init</a> (<a class="el" href="structec__debug__t.html">ec_debug_t</a> *, <a class="el" href="ecdev_8h.html#ac0895793ea540357d225d4b8be71f2e4">ec_device_t</a> *, const char *)</td></tr>
<tr class="memdesc:aa8debb37c58f6813ddefa8233095f496"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug interface constructor.  <a href="#aa8debb37c58f6813ddefa8233095f496">More...</a><br /></td></tr>
<tr class="separator:aa8debb37c58f6813ddefa8233095f496"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf7590df1f37cbc094a03b6dd339a007"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#aaf7590df1f37cbc094a03b6dd339a007">ec_debug_clear</a> (<a class="el" href="structec__debug__t.html">ec_debug_t</a> *)</td></tr>
<tr class="memdesc:aaf7590df1f37cbc094a03b6dd339a007"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug interface destructor.  <a href="#aaf7590df1f37cbc094a03b6dd339a007">More...</a><br /></td></tr>
<tr class="separator:aaf7590df1f37cbc094a03b6dd339a007"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d9b504f3765f22ec81c6e332f542add"><td class="memItemLeft" align="right" valign="top"><a id="a1d9b504f3765f22ec81c6e332f542add"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#a1d9b504f3765f22ec81c6e332f542add">ec_debug_register</a> (<a class="el" href="structec__debug__t.html">ec_debug_t</a> *, const struct net_device *)</td></tr>
<tr class="memdesc:a1d9b504f3765f22ec81c6e332f542add"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register debug interface. <br /></td></tr>
<tr class="separator:a1d9b504f3765f22ec81c6e332f542add"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed729c6112e274fb57539f57f0101c59"><td class="memItemLeft" align="right" valign="top"><a id="aed729c6112e274fb57539f57f0101c59"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#aed729c6112e274fb57539f57f0101c59">ec_debug_unregister</a> (<a class="el" href="structec__debug__t.html">ec_debug_t</a> *)</td></tr>
<tr class="memdesc:aed729c6112e274fb57539f57f0101c59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister debug interface. <br /></td></tr>
<tr class="separator:aed729c6112e274fb57539f57f0101c59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69e2cddd7db5ff1ac8b3e1896e7cc862"><td class="memItemLeft" align="right" valign="top"><a id="a69e2cddd7db5ff1ac8b3e1896e7cc862"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="debug_8h.html#a69e2cddd7db5ff1ac8b3e1896e7cc862">ec_debug_send</a> (<a class="el" href="structec__debug__t.html">ec_debug_t</a> *, const uint8_t *, size_t)</td></tr>
<tr class="memdesc:a69e2cddd7db5ff1ac8b3e1896e7cc862"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends frame data to the interface. <br /></td></tr>
<tr class="separator:a69e2cddd7db5ff1ac8b3e1896e7cc862"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Network interface for debugging purposes. </p>

<p class="definition">Definition in file <a class="el" href="debug_8h_source.html">debug.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aa8debb37c58f6813ddefa8233095f496"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8debb37c58f6813ddefa8233095f496">&#9670;&nbsp;</a></span>ec_debug_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_debug_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__debug__t.html">ec_debug_t</a> *&#160;</td>
          <td class="paramname"><em>dbg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="ecdev_8h.html#ac0895793ea540357d225d4b8be71f2e4">ec_device_t</a> *&#160;</td>
          <td class="paramname"><em>device</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Debug interface constructor. </p>
<p>Initializes the debug object, creates a net_device and registeres it.</p>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">0</td><td>Success. </td></tr>
    <tr><td class="paramname">&lt;0</td><td>Error code. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dbg</td><td>Debug object. </td></tr>
    <tr><td class="paramname">device</td><td>EtherCAT device. </td></tr>
    <tr><td class="paramname">name</td><td>Interface name. </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="debug_8c_source.html#l00074">74</a> of file <a class="el" href="debug_8c_source.html">debug.c</a>.</p>

</div>
</div>
<a id="aaf7590df1f37cbc094a03b6dd339a007"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf7590df1f37cbc094a03b6dd339a007">&#9670;&nbsp;</a></span>ec_debug_clear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ec_debug_clear </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structec__debug__t.html">ec_debug_t</a> *&#160;</td>
          <td class="paramname"><em>dbg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Debug interface destructor. </p>
<p>Unregisters the net_device and frees allocated memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dbg</td><td>debug object </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="debug_8c_source.html#l00115">115</a> of file <a class="el" href="debug_8c_source.html">debug.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="debug_8h.html">debug.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
